
/**
 * Copyright 2009 cestum.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
package org.waveprotocol.wave.model.wave.data {
import mx.collections.ArrayCollection;

import org.waveprotocol.wave.model.id.WaveId;
import org.waveprotocol.wave.model.id.WaveletId;

/**
 * wave-protocol's data structure
 **/
public interface WaveViewData {

	/**
	 * Gets the unique identifier of the wave in view.
	 *
	 */
	function getWaveId():WaveId ;
	
	/**
	 * Gets the wavelets in this wave view. The order of iteration is unspecified.
	 *
	 */
	function getWavelets():Array;
	
	/**
	 * Gets a wavelet from the view by id.
	 *
	 */
	function getWavelet(waveletId:WaveletId):WaveletData ;
	
	/**
	 * Creates a new wavelet in the wave.
	 */
	function createWavelet(waveletId:WaveletId):WaveletData ;
	
	/**
	 * Removes a wavelet in the wave.
	 */
	function removeWavelet(waveletId:WaveletId):void ;
}
}